Implements transfer_locked_position instruction in ts-sdk #940

boosik-sol · 2025-05-09T08:08:26Z

This PR is implementing transfer_locked_position instruction in ts-sdk.

implementing instruction
unit test
testing in devnet, mainnet

boosik-sol · 2025-05-09T08:15:51Z

ts-sdk/whirlpool/tests/transferLockedPosition.test.ts

+    }
+  });
+
+  const testTransferLockedPositionInstructions = async (


I intended to test following

position owner opens new position

lock it

try to transfer locked position

after transfer, verify if position is exsit, and locked.

ts-sdk/whirlpool/tests/utils/tokenExtensions.ts

boosik-sol · 2025-05-09T19:37:29Z

No lockPosition test code, so need to test it first.

ts-sdk/whirlpool/src/transferLockedPosition.ts

ts-sdk/whirlpool/tests/transferLockedPosition.test.ts

boosik-sol · 2025-05-10T15:39:13Z

ts-sdk/whirlpool/tests/lockPosition.test.ts

+
+  for (const poolName of poolTypes.keys()) {
+    for (const positionTypeName of positionTypes.keys()) {
+      const positionNameTE = `TE ${poolName} ${positionTypeName}`;


Question) It seems if we open position with setupPosition(not supporting token extension), we couldn't lock position because it's token mint will be legacy SPL.
Are there any possible effects in real service? Like, if users open their position with open_position_instruction (not open_position_instruction_with_token_extension, they might not be able to lock position.

Isn't there a setupTEPosition function?

Yap, I tested only positions made with setupTEPosition. But what I am wondering is that if we need to support lockPosition with position made with setupPosition. This case was failed. (So I didn't add this case.)

I recommend that. we should have a test case to verify that non-TE tokens cannot use transfer lock just to be complete.

ts-sdk/whirlpool/tests/utils/tokenExtensions.ts

wjthieme

Almost there! Couple of small comments left

ts-sdk/whirlpool/src/transferLockedPosition.ts

wjthieme · 2025-05-13T18:19:01Z

ts-sdk/whirlpool/tests/lockPosition.test.ts

@@ -0,0 +1,154 @@
+import { describe, it, beforeAll } from "vitest";


Is this from the other PR?

No, I include lockPosition test case in this PR. Because lockPosition and transferLockedPosition share same logics, but there is no lockPosition test code.

boosik-sol · 2025-05-15T15:38:18Z

ts-sdk/whirlpool/src/transferLockedPosition.ts

+    tokenProgram: positionMint.programAddress,
+  });
+
+  const lockConfigPda = await getProgramDerivedAddress({


@wjthieme Could we use this with @orca-so/whirlpool-client? I think it is not exported. Or, I will move this to utils.ts when I fix lockPosition.ts

Yeah if the function is not yet in @orca-so/whirlpool-client (or not exported) feel free to add/change it there!

odcheung · 2025-05-23T18:02:54Z

ts-sdk/whirlpool/tests/lockPosition.test.ts

+  for (const poolName of poolTypes.keys()) {
+    for (const positionTypeName of positionTypes.keys()) {


can we try to use test.for?

There are several codes using this pattern, so how about fix them together?

odcheung · 2025-05-23T18:23:21Z

ts-sdk/whirlpool/tests/lockPosition.test.ts

+
+  for (const poolName of poolTypes.keys()) {
+    for (const positionTypeName of positionTypes.keys()) {
+      const positionNameTE = `TE ${poolName} ${positionTypeName}`;


I recommend that. we should have a test case to verify that non-TE tokens cannot use transfer lock just to be complete.

odcheung · 2025-05-23T18:48:58Z

ts-sdk/whirlpool/tests/lockPosition.test.ts

+  ["one sided B", { tickLower: 1, tickUpper: 100 }],
+]);
+
+describe("LockPosition instructions", () => {


Suggest we add more test cases to cover all the parameter that this function takes in:
ex:

receiver (self vs un-related wallet)

authority (funder vs another wallet that owns the position vs another wallet that doesn't own the position)

position mint types (TE vs non-TE) ✅

position lock state (locked vs unlocked) ✅

make more tc about case 2, but could you describe more about case 1? is there receiver in lock-position?

Sorry to clarify, this function takes in the receiver as where the locked position can be transferred to. Assuming walletA owns the locked position today, edge cases are:

What if walletA sets walletA as receiver? (tries to send to self)

walletA -> walletB (normal case)

yugure-orca

Could you apply the following two changes?
The PR has been open for a while, so I’d like to make only these changes and then merge it.

~~Export lockConfig.ts in ts-sdk/client/src/pda/index.ts and~~ (PR1034 did it) use getLockConfigAddress to derive lock config PDA.
Add an instruction to idempotently initialize the destinationTokenAccount (ATA).

Since @orca-so/whirlpools provides high-level functions, it will create required ATAs. However, transfer_locked_position instruction does not initialize the destination in the instruction itself, so I think it’s better to provide an ATA initialization instruction on the client side.

Regarding test cases, scenarios blocked at the contract level (e.g., non-TE positions cannot be locked or transferred) are already covered in the legacy-sdk integration tests.
(There’s no need to remove them.) It’s not mandatory for ts-sdk tests to verify that the contract rejects these cases.

boosik-sol requested review from odcheung, wjthieme and yugure-orca as code owners May 9, 2025 08:08

boosik-sol force-pushed the boosik/impl_transfer_locked_position_ts_sdk branch 2 times, most recently from 4664190 to 7af6810 Compare May 9, 2025 08:11

boosik-sol commented May 9, 2025

View reviewed changes

boosik-sol force-pushed the boosik/impl_transfer_locked_position_ts_sdk branch from 7af6810 to 1ca7fcd Compare May 9, 2025 09:01

boosik-sol commented May 9, 2025

View reviewed changes

ts-sdk/whirlpool/tests/utils/tokenExtensions.ts Outdated Show resolved Hide resolved

boohyunsik reviewed May 9, 2025

View reviewed changes

ts-sdk/whirlpool/tests/utils/tokenExtensions.ts Show resolved Hide resolved

wjthieme reviewed May 9, 2025

View reviewed changes

ts-sdk/whirlpool/src/transferLockedPosition.ts Outdated Show resolved Hide resolved

wjthieme reviewed May 9, 2025

View reviewed changes

ts-sdk/whirlpool/tests/transferLockedPosition.test.ts Outdated Show resolved Hide resolved

boosik-sol force-pushed the boosik/impl_transfer_locked_position_ts_sdk branch from 097394e to 757b2b3 Compare May 10, 2025 15:29

boosik-sol commented May 10, 2025

View reviewed changes

boosik-sol force-pushed the boosik/impl_transfer_locked_position_ts_sdk branch 2 times, most recently from 5377182 to 0e7cff2 Compare May 10, 2025 17:04

wjthieme reviewed May 12, 2025

View reviewed changes

ts-sdk/whirlpool/tests/utils/tokenExtensions.ts Outdated Show resolved Hide resolved

wjthieme reviewed May 13, 2025

View reviewed changes

boosik-sol commented May 15, 2025

View reviewed changes

boosik-sol force-pushed the boosik/impl_transfer_locked_position_ts_sdk branch 2 times, most recently from 60750f4 to b3efc44 Compare May 19, 2025 15:35

odcheung reviewed May 23, 2025

View reviewed changes

boosik-sol force-pushed the boosik/impl_transfer_locked_position_ts_sdk branch 2 times, most recently from afb9132 to 222c93e Compare May 28, 2025 14:05

boosik-sol added 6 commits August 11, 2025 21:08

Implements instruction for transffering locked position in kit-sdk

7dc88e1

Add unit test for transfer_locked_position instruction in ts-sdk

8cdccc7

Add comments to each parameter in TransferLockedPositionParams

8833adb

Implements lockPosition test code

82718eb

fix: lint

87a4560

fix: rollback mint-authority in test case

e44b072

boosik-sol added 9 commits August 11, 2025 21:08

fix: getting address in setupAta owner

733e095

fix: lint

ac692b3

fix: derive addresses from position

b7c3aac

fix: add comments

6019170

feat: add testcase that should fail when not TE

0c5d73e

feat: test case that failed when signer and owner is different

dcb7c4d

feat: add more tc

9f09682

fix: format

1266a6d

tc: add verification that failed to send locked position to myself

c59ceda

boosik-sol force-pushed the boosik/impl_transfer_locked_position_ts_sdk branch from 222c93e to c59ceda Compare August 11, 2025 12:08

yugure-orca reviewed Aug 12, 2025

View reviewed changes

		@@ -0,0 +1,154 @@
		import { describe, it, beforeAll } from "vitest";

		for (const poolName of poolTypes.keys()) {
		for (const positionTypeName of positionTypes.keys()) {

Implements transfer_locked_position instruction in ts-sdk #940

Are you sure you want to change the base?

Implements transfer_locked_position instruction in ts-sdk #940

Uh oh!

Conversation

boosik-sol commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

boosik-sol commented May 9, 2025

Uh oh!

Uh oh!

Uh oh!

boosik-sol May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

boosik-sol May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wjthieme left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yugure-orca left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

boosik-sol commented May 9, 2025 •

edited

Loading

boosik-sol May 10, 2025 •

edited

Loading

boosik-sol May 12, 2025 •

edited

Loading

yugure-orca left a comment •

edited

Loading